Input formats¶
OB score currently supports formats provided by:
In this page, format of required data is shown. Non necessary data is not shown in requests specifiaction for clarity. Raw output from all these data providers is supported.
API is accessed with POST request with data in json file. Json files in request need to have 2 extra values:
userKey - Unique ID that is provided to you by OB score.
scorecard - ID of scorecard that you have access to.
Instantor¶
URL for scoring instantor data: https://www.obscore.com/score
Input
{
"processStartTime": "2018-08-31T00:00:00.000+0000",
"accountList": [
{
"number": "3000001",
"transactionList": [
{
"onDate": "2018-08-03",
"description": "Description: REINT.CAJERO",
"amount": -20.00,
"balance": 32.13
},
{
"onDate": "2018-08-03",
"description": "Description: REINT.CAJERO",
"amount": -20.00,
"balance": 12.13
},
{
"onDate": "2018-08-05",
"description": "Description: DUPLICADO TARJETA",
"amount": -4.00,
"balance": 8.13
},
{
"onDate": "2018-08-13",
"description": "Description: SANTANDER CONS - Recibo entidad de financiacion",
"amount": -215.10,
"balance": -206.97
}
]
},
{
"number": "3000002",
"transactionList": ["..."
]
}
]
}
Unnax¶
URL for scoring unnax data: https://www.obscore.com/score_unnax
Input
{
"accounts": [
{
"_id": "ES1899992020841308020274",
"last_update": "2020-02-08T12:57:49+00:00",
},
{
"_id": "ES7299992020871308020416",
"last_update": "2020-02-09T12:57:49+00:00",
},
"..."
]
"statements": [
{
"account": "ES1899992020841308020274",
"amount": 13030,
"balance": 13030,
"concepts": [
"Unnax Certification 1"
],
"value_date": "2020-02-13"
},
{
"account": "ES1899992020841308020274",
"amount": 21550,
"balance": 34580,
"concepts": [
"Unnax Certification 2"
],
"value_date": "2020-02-13"
},
"..."
]
}
Equifax¶
URL for scoring equifax data: https://www.obscore.com/score_equifax
Input
{
"applicants":{
"dataSourceResponses":{
"BANKINGREPORTS":{
"BANKINGREPORTS":{
"accountList":[
{
"number":"ES0321005689660100282827",
"balance":1.6,
"transactionList":[
{
"amount":-1,
"balance":1.6,
"onDate":"2021-01-25",
"description":"Description: PRESTAMER"
},
{
"amount":-6.78,
"balance":2.6,
"onDate":"2021-01-24",
"description":"Description: Ding"
},
"..."
]
},
"..."
]
}}}},
"miscParams":[
"...",
{
"name":"processFinishedTime",
"value":"2021-01-27"
},
"..."
]
}
Tink¶
We support both instantor formats. New format is available at score_tink and older format is available at score_tink_legacy.
URL for scoring tink data in new format: https://www.obscore.com/score_tink
Input
{
"data": {
"accounts": {
"accounts": [
{
"balance": 10323.31,
"certainDate": 1604444400000,
"id": "14f504c7f649404895f64b5104e68309",
}
]
},
"transactions": {
"results": [
{
"transaction": {
"accountId": "14f504c7f649404895f64b5104e68309",
"amount": -39.98,
"date": 1604574000000,
"description": "Decathlon On Line",
}
},
{
"transaction": {
"accountId": "14f504c7f649404895f64b5104e68309",
"amount": -6.4,
"date": 1602756000000,
"description": "Mkgranada2",
},
},
"..."
]
}
}
URL for scoring tink data in old format: https://www.obscore.com/score_tink_legacy
Input
{
"data": {
"accounts": {
"accounts": [{
"id": "d5449c1a715e4197bc526fb1dbd39d9a",
"balances": {
"booked": {
"amount": {
"value": {
"unscaledValue": "-14247",
},
}
}
},
"dates": {
"lastRefreshed": "2021-04-19T15:05:24Z"
}
}, {
"id": "f69380e555884319aa4e118a3b43734c",
"name": "Loan",
"type": "UNDEFINED",
"balances": {
"booked": {
"amount": {
"value": {
"unscaledValue": "-22505",
},
}
}
},
"dates": {
"lastRefreshed": "2021-04-19T15:05:24Z"
},
}
],
}
}
"transactions": {
"transactions": [{
"accountId": "e308b48888154f3ca2ce668a1a82ecd5",
"amount": {
"value": {
"unscaledValue": "-500",
},
},
"descriptions": {
"original": "Withdrawal",
},
"dates": {
"booked": "2021-04-19"
}
}, {
"accountId": "af143e645104497fb7220eaa73098c38",
"amount": {
"value": {
"unscaledValue": "-500",
},
},
"descriptions": {
"original": "Withdrawal",
},
"dates": {
"booked": "2021-04-19"
},
}]}
}